home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 001 / kerm228.arc / MSKERM.HLP < prev    next >
Encoding:
Text File  |  1985-06-15  |  9.6 KB  |  245 lines
  1.  
  2.  
  3.                KERMIT VERSION 2.28 FOR MS-DOS AND PC-DOS
  4.  
  5.                              June 10, 1985
  6.  
  7. Kermit-MS is a program that provides terminal emulation and file trans-
  8. fer for Intel 8088- and 8086-based microcomputers running the MS-DOS or
  9. PC-DOS operating system.  The Kermit file transfer protocol was
  10. developed and the Kermit-MS program were developed at the Columbia
  11. University Center for Computing Activities.
  12.  
  13.  
  14. * Program Operation
  15.  
  16. Kermit-MS can be run interactively, from a batch file, or as an
  17. "external" DOS command.  Commands consist of one or more fields,
  18. separated by "whitespace" -- one or more spaces or tabs.  Upon startup,
  19. the program executes any commands found in the file MSKERMIT.INI in the
  20. current path.
  21.  
  22. . Interactive Operation:
  23.  
  24. To run Kermit-MS interactively, invoke the program from DOS command
  25. level by typing its name.  When you see the command's prompt,
  26. "Kermit-MS>", you may type Kermit commands repeatedly until you are
  27. ready to exit the program.  You can use these special characters while
  28. typing commands.
  29.  
  30. BACKSPACE  Delete the character most recently typed.  May be typed
  31.         repeatedly to delete backwards.  You may also use DELETE,
  32.         RUBOUT, or equivalent keys.
  33.  
  34. CTRL-W  Delete the most recent "word", or field, on the command line.
  35.         May be typed repeatedly.
  36.  
  37. CTRL-U  Delete the entire command line.
  38.  
  39. CTRL-C  Cancel the current command and return to the "Kermit-MS>"
  40.         prompt.
  41.  
  42. ?       Type a brief message describing what you are expected to type in
  43.         the current field.
  44.  
  45. ESC     If enough characters have been supplied in the current field
  46.         (keyword or file name) to uniquely identify it, supply the
  47.         remainder of the field and position to the next field of the
  48.         command.  Otherwise, sound a beep.
  49.  
  50. =       Wildcard character for matching single characters in filenames,
  51.         equivalent to MS-DOS "?".
  52.  
  53. . Command Line Invocation:
  54.  
  55. Kermit-MS may also be invoked with command line arguments from DOS com-
  56. mand level, for instance:
  57.  
  58.     A>kermit send foo.bar
  59. or
  60.     A>kermit set port 1, set baud 9600, connect
  61.  
  62. When invoked with command line arguments, Kermit-MS will behave as if it
  63. were an external DOS command, like MODE.  Note that several commands may
  64. be given on the command line, separated by commas.
  65.  
  66.  
  67. * Kermit-MS Commands
  68.  
  69. Kermit-MS V2.28 has the following commands:
  70.  
  71.           BYE  to remote server.
  72.         CLEAR  key redefinitions.
  73.         CLOSE  log file and stop logging remote session.
  74.       CONNECT  as terminal to remote system.
  75.           CWD  change local working directory.
  76.        DEFINE  macros of Kermit-MS commands.
  77.        DELETE  local files.
  78.     DIRECTORY  listing of local files.
  79.            DO  a macro expansion.
  80.          EXIT  from Kermit-MS.
  81.        FINISH  Shut down remote server.
  82.           GET  remote files from server.
  83.          HELP  about Kermit-MS.
  84.         LOCAL  prefix for local file management commands.
  85.           LOG  remote terminal session.
  86.        LOGOUT  remote server.
  87.          PUSH  to MS-DOS command level.
  88.          QUIT  from Kermit-MS
  89.       RECEIVE  files from remote Kermit.
  90.        REMOTE  prefix for remote file management commands.
  91.           RUN  an MS-DOS program.
  92.          SEND  files to remote Kermit.
  93.        SERVER  mode of remote operation.
  94.           SET  various parameters.
  95.          SHOW  various parameters.
  96.         SPACE  inquiry.
  97.        STATUS  inquiry.
  98.          TAKE  commands from file.
  99.          TYPE  display a local file.
  100.       VERSION  display Kermit-MS program version number.
  101.  
  102. The following SET commands are available in Kermit-MS:
  103.  
  104.             AUTOWRAP  Controls line wrap during terminal emulation
  105.                 BAUD  Communications port line speed
  106.                 BELL  Whether to beep at the end of a transaction
  107.     BLOCK-CHECK-TYPE  Level of error checking for file transfer
  108.                DEBUG  Display packet contents during file transfer
  109.         DEFAULT-DISK  Default disk drive for file i/o
  110.          DESTINATION  Default destination device for incoming files
  111.          END-OF-LINE  Packet terminator
  112.                  EOF  Method for determining or marking end of file
  113.               ESCAPE  Escape character for CONNECT
  114.         FLOW-CONTROL  Enable or disable XON/XOFF
  115.            HANDSHAKE  Half-duplex line turnaround option
  116.              HEATH19  Heath/Zenith-19 terminal emulation
  117.           INCOMPLETE  What to do with an incompletely received file
  118.                  KEY  Specify key redefinitions, or "keystroke macros"
  119.           LOCAL-ECHO  Specify which host does the echoing during CONNECT
  120.            MODE-LINE  Whether to display mode line in terminal emulation
  121.               PARITY  Character parity to use
  122.                 PORT  Select a communications port
  123.               PROMPT  Change the "Kermit-MS>" prompt to something else
  124.              RECEIVE  Request remote Kermit to use specified parameters
  125.               REMOTE  For running Kermit-MS interactively from back port
  126.                 SEND  Use the specified parameters during file transfer
  127.            TAKE-ECHO  Control echoing of commands from TAKE files
  128.                TIMER  Enable/disable timeouts during file transfer
  129.              WARNING  Specify how to handle filename collisions
  130.  
  131. The STATUS command shows the values of parameters which may be SET.  The
  132. SHOW command displays current key or macro definitions.
  133.  
  134.  
  135. * Command Macros
  136.  
  137. Kermit-MS provides a facility for combining commands into "macros."
  138. Command macro definitions may be included in your MSKERMIT.INI file,
  139. TAKEn explicitly from a specified file, or typed interactively, and may
  140. be invoked with the DO command.
  141.  
  142.  
  143. * Command Macros
  144.  
  145. Kermit-MS command macros are constructed with the DEFINE command.  The
  146. syntax is 
  147.  
  148.     DEFINE macro-name  [command [, command [, ...]]]
  149.  
  150. Any Kermit-MS commands may be included.  Example:
  151.  
  152.     define telenet set parity mark, set baud 1200, connect
  153.  
  154. A Kermit-MS command macro is invoked using the DO command.  For in-
  155. stance, Kermit-MS comes with a predefined macro to allow convenient
  156. setup for IBM communications; to invoke it, you would type 
  157.  
  158.     do ibm
  159.  
  160. The IBM macro is defined as "parity mark, handshake xon, local-echo on,
  161. timer on".  You can delete or replace this definition by adding a new
  162. (perhaps null) definition, such as
  163.  
  164.     define ibm parity even, handshake cr, local-echo on, timer on]
  165. or
  166.     define ibm
  167.  
  168. Command macro definitions can be displayed with the SHOW MACROS command.
  169.  
  170.  
  171. * Terminal Emulation
  172.  
  173. Here are the terminal emulation options for the systems presently sup-
  174. ported by Kermit-MS:
  175.  
  176.   System         EscChar   Cabilities   Terminal Service
  177.   IBM PC, XT       ^]      R M P K      Heath19 emulation
  178.   DEC Rainbow      ^]      R   P K      VT102 firmware
  179.   HP-150           ^]      R            HP-2623 firmware
  180.   Wang PC          ^A                   Wang firmware
  181.   Generic DOS      ^]                   Depends on system
  182.  
  183. Under Capabilities, R means rollback, M means mode line, P means printer
  184. control, and K means key redefinition.
  185.  
  186. Kermits that use the built-in Heath-19 emulation can disable it with the
  187. SET HEATH OFF command and use an external console device driver like
  188. ANSI.SYS instead.
  189.  
  190. During terminal connection, the escape character is used to regain the
  191. attention of Kermit-MS.  When you type the escape character, Kermit-MS
  192. waits for you to follow it with a single character command:
  193.  
  194.   ?   Help -- prints the available single-character commands.
  195.   C   Close the connection and return to Kermit-MS prompt level.
  196.   S   Show the status of the connection.
  197.   B   Send a BREAK signal to the port.
  198.   0   (the digit zero) Send a NUL (ASCII 0) to the port.
  199.   Q   Temporarily quit logging the remote session.
  200.   R   Resume logging the remote session.
  201.   M   Toggle the mode line, i.e. turn it off if it is on & vice versa.
  202.   ^]  (or whatever you have set the escape character to be)
  203.       Typing the escape character twice sends one copy of it to the con-
  204.       nected host.
  205.  
  206. Typing any other character (except the space bar, which is the "null
  207. command") after the escape character will cause Kermit-MS to beep, but
  208. will do no harm.  The escape character can be changed to something other
  209. than Control-Rightbracket by using the SET ESCAPE command.
  210.  
  211. Kermit-MS includes several advanced features for use during terminal
  212. emulation, including screen scroll, printer control, and key redefini-
  213. tions.
  214.  
  215. . Screen Scroll
  216.  
  217. Kermit-MS provides several pages of screen memory, which may be scrolled
  218. up and down using keys as follows:
  219.  
  220.   Function            IBM PC/XT   Rainbow           HP-150
  221.   Screen Down         PgUp        PrevScreen        Prev
  222.   Line Down           Ctrl-PgUp   Ctrl-PrevScreen   Shift-UpArrow
  223.   Screen Up           PgDn        NextScreen        Next
  224.   Line Up             Ctrl-PgDn   Ctrl-NextScreen   Shift-DownArrow
  225.   Top of Memory       Home
  226.   Bottom of Memory    End
  227.  
  228. . Printer Control
  229.  
  230. A locally attached printer may be controlled in the normal manner, on
  231. most systems.  Pushing the "Print Screen" key (shifted on some systems)
  232. will cause the current contents of the screen to be printed or spooled;
  233. holding down CTRL while depressing Print Screen will start or stop the
  234. spooling of incoming characters to the printer.
  235.  
  236. CTRL-Print-Screen can be simulated with the Kermit-MS LOG PRN and CLOSE
  237. commands.
  238.  
  239. . Key Redefinitions
  240.  
  241. Use SHOW KEY to find out the scan code of the key you want to redefine,
  242. then use SET KEY SCAN xxx to define the new value.  Control characters
  243. are entered in the definition string as \ooo (a backslash followed by 2
  244. or 3 octal digits denoting the ASCII value of the character).
  245.